All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.ComponentView 

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.swing.text.ComponentView
public class ComponentView
extends View
Component decorator that implements the view interface. The entire element is used to represent the component. This acts as a gateway from the display-only View implementations to interactive lightweight components (ie it allows components to be embedded into the View hierarchy. The parent of the component is the container that is handed out by the associated view factory.

Constructor Index

o ComponentView(Element)
Creates a new ComponentView object.

Method Index

o getAlignment(int)
Determines the desired alignment for this view along an axis.
o getPreferredSpan(int)
Determines the preferred span for this view along an axis.
o modelToView(int, Shape)
Provides a mapping from the coordinate space of the model to that of the view.
o paint(Graphics, Shape)
Paints a component view.
o setParent(View)
Sets the parent for a child view.
o setSize(float, float)
Sets the size of the view.
o viewToModel(float, float, Shape)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Constructors

o ComponentView 
 public ComponentView(Element elem)
Creates a new ComponentView object.

Parameters:
elem - the element to decorate

Methods

o paint 
 public void paint(Graphics g,
                   Shape a)
Paints a component view. The real paint behavior occurs naturally from the association that the component has with its parent container (the same container hosting this view), so this simply allows us to position the component properly relative to the view. Since the coordinate system for the view is simply the parent containers, positioning the child component is easy.

Parameters:
g - the graphics context
a - the shape
Overrides:
paint in class View
See Also:
paint
o getPreferredSpan 
 public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
s the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.
Throws: IllegalArgumentException
for an invalid axis
Overrides:
getPreferredSpan in class View
o getAlignment 
 public float getAlignment(int axis)
Determines the desired alignment for this view along an axis. This is implemented to give the alignment of the embedded component.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
s the desired alignment. This should be a value between 0.0 and 1.0 where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin. An alignment of 0.5 would be the center of the view.
Overrides:
getAlignment in class View
o setSize 
 public void setSize(float width,
                     float height)
Sets the size of the view.

Parameters:
width - the width >= 0
height - the height >= 0
Overrides:
setSize in class View
o setParent 
 public void setParent(View p)
Sets the parent for a child view. The parent calls this on the child to tell it who its parent is. If this is null, the view has been removed and we need to remove the associated component from its parent.

Parameters:
p - the parent
Overrides:
setParent in class View
o modelToView 
 public Shape modelToView(int pos,
                          Shape a) throws BadLocationException
Provides a mapping from the coordinate space of the model to that of the view.

Parameters:
pos - the position to convert >= 0
a - the allocated region to render into
Returns:
the bounding box of the given position is returned
Throws: BadLocationException
if the given position does not represent a valid location in the associated document
Overrides:
modelToView in class View
See Also:
modelToView
o viewToModel 
 public int viewToModel(float x,
                        float y,
                        Shape a)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
a - the allocated region to render into
Returns:
the location within the model that best represents the given point in the view
Overrides:
viewToModel in class View
See Also:
viewToModel 
All Packages  Class Hierarchy  This Package  Previous  Next  Index